.\" Man page generated from reStructuredText.
.
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "CMAKE-GENERATORS" "7" "Aug 27, 2025" "4.1.1" "CMake"
.SH NAME
cmake-generators \- CMake Generators Reference
.SH INTRODUCTION
.sp
A \fICMake Generator\fP is responsible for writing the input files for
a native build system.  Exactly one of the \fI\%CMake Generators\fP must be
selected for a build tree to determine what native build system is to
be used.  Optionally one of the \fI\%Extra Generators\fP may be selected
as a variant of some of the \fI\%Command\-Line Build Tool Generators\fP to
produce project files for an auxiliary IDE.
.sp
CMake Generators are platform\-specific so each may be available only
on certain platforms.  The \fI\%cmake(1)\fP command\-line tool
\fI\%\-\-help\fP output lists available generators on the
current platform.  Use its \fI\%\-G\fP option to specify the
generator for a new build tree. The \fI\%cmake\-gui(1)\fP offers
interactive selection of a generator when creating a new build tree.
.SH CMAKE GENERATORS
.SS Command\-Line Build Tool Generators
.sp
These generators support command\-line build tools.  In order to use them,
one must launch CMake from a command\-line prompt whose environment is
already configured for the chosen compiler and build tool.
.SS Makefile Generators
.SS Borland Makefiles
.sp
Generates Borland makefiles.
.SS MSYS Makefiles
.sp
Generates makefiles for use with MSYS (Minimal SYStem)
\fBmake\fP under the MSYS shell.
.sp
Use this generator in a MSYS shell prompt and using \fBmake\fP as the build
tool.  The generated makefiles use \fB/bin/sh\fP as the shell to launch build
rules.  They are not compatible with a Windows command prompt.
.sp
To build under a Windows command prompt, use the
\fI\%MinGW Makefiles\fP generator.
.SS MinGW Makefiles
.sp
Generates makefiles for use with \fBmingw32\-make\fP under a Windows command
prompt.
.sp
Use this generator under a Windows command prompt with
MinGW (Minimalist GNU for Windows) in the \fBPATH\fP
and using \fBmingw32\-make\fP as the build tool.  The generated makefiles use
\fBcmd.exe\fP as the shell to launch build rules.  They are not compatible with
MSYS or a unix shell.
.sp
To build under the MSYS shell, use the \fI\%MSYS Makefiles\fP generator.
.SS NMake Makefiles
.sp
Generates NMake makefiles.
.SS NMake Makefiles JOM
.sp
Generates JOM makefiles.
.sp
Added in version 3.8: \fI\%CodeBlocks\fP generator can be used as an extra generator.

.SS Unix Makefiles
.sp
Generates standard UNIX makefiles.
.sp
A hierarchy of UNIX makefiles is generated into the build tree.  Use
any standard UNIX\-style make program to build the project through
the \fBall\fP target and install the project through the \fBinstall\fP
(or \fBinstall/strip\fP) target.
.sp
For each subdirectory \fBsub/dir\fP of the project a UNIX makefile will
be created, containing the following targets:
.INDENT 0.0
.TP
.B \fBall\fP
Depends on all targets required by the subdirectory.
.TP
.B \fBinstall\fP
Runs the install step in the subdirectory, if any.
.TP
.B \fBinstall/strip\fP
Runs the install step in the subdirectory followed by a \fBCMAKE_STRIP\fP command,
if any.
.sp
The \fBCMAKE_STRIP\fP variable will contain the platform\(aqs \fBstrip\fP utility, which
removes symbols information from generated binaries.
.TP
.B \fBtest\fP
Runs the test step in the subdirectory, if any.
.TP
.B \fBpackage\fP
Runs the package step in the subdirectory, if any.
.UNINDENT
.SS Watcom WMake
.sp
Generates Watcom WMake makefiles.
.SS Ninja Generators
.SS Ninja
.sp
Generates a \fBbuild.ninja\fP file into the build tree.
.SS Builtin Targets
.sp
\fBall\fP
.INDENT 0.0
.INDENT 3.5
Depends on all targets required by the project, except those with
\fI\%EXCLUDE_FROM_ALL\fP set to true.
.UNINDENT
.UNINDENT
.sp
\fBinstall\fP
.INDENT 0.0
.INDENT 3.5
Runs the install step.
.UNINDENT
.UNINDENT
.sp
\fBinstall/strip\fP
.INDENT 0.0
.INDENT 3.5
Added in version 3.7: Runs the install followed by a \fBCMAKE_STRIP\fP command, if any.
.sp
The \fBCMAKE_STRIP\fP variable will contain the platform\(aqs \fBstrip\fP utility, which
removes symbols information from generated binaries.

.UNINDENT
.UNINDENT
.sp
\fBinstall/parallel\fP
.INDENT 0.0
.INDENT 3.5
Added in version 3.30: Created only if the \fI\%INSTALL_PARALLEL\fP global property is \fBON\fP\&.
Runs the install step for each subdirectory independently and in parallel.

.UNINDENT
.UNINDENT
.sp
For each subdirectory \fBsub/dir\fP of the project, additional targets
are generated:
.sp
\fBsub/dir/all\fP
.INDENT 0.0
.INDENT 3.5
Added in version 3.6: Depends on all targets required by the subdirectory.

.UNINDENT
.UNINDENT
.sp
\fBsub/dir/install\fP
.INDENT 0.0
.INDENT 3.5
Added in version 3.7: Runs the install step in the subdirectory, if any.

.UNINDENT
.UNINDENT
.sp
\fBsub/dir/install/strip\fP
.INDENT 0.0
.INDENT 3.5
Added in version 3.7: Runs the install step in the subdirectory followed by a \fBCMAKE_STRIP\fP command,
if any.

.UNINDENT
.UNINDENT
.sp
\fBsub/dir/test\fP
.INDENT 0.0
.INDENT 3.5
Added in version 3.7: Runs the test step in the subdirectory, if any.

.UNINDENT
.UNINDENT
.sp
\fBsub/dir/package\fP
.INDENT 0.0
.INDENT 3.5
Added in version 3.7: Runs the package step in the subdirectory, if any.

.UNINDENT
.UNINDENT
.SS Fortran Support
.sp
Added in version 3.7.

.sp
The \fBNinja\fP generator conditionally supports Fortran when the \fBninja\fP
tool is at least version 1.10 (which has the required features).
.SS Swift Support
.sp
Added in version 3.15.

.sp
The Swift support is experimental, not considered stable, and may change
in future releases of CMake.
.SS See Also
.sp
Added in version 3.17: The \fI\%Ninja Multi\-Config\fP generator is similar to the \fBNinja\fP
generator, but generates multiple configurations at once.

.SS Ninja Multi\-Config
.sp
Added in version 3.17.

.sp
Generates multiple \fBbuild\-<Config>.ninja\fP files.
.sp
This generator is very much like the \fI\%Ninja\fP generator, but with
some key differences. Only these differences will be discussed in this
document.
.sp
Unlike the \fI\%Ninja\fP generator, \fBNinja Multi\-Config\fP generates
multiple configurations at once with \fI\%CMAKE_CONFIGURATION_TYPES\fP
instead of only one configuration with \fI\%CMAKE_BUILD_TYPE\fP\&. One
\fBbuild\-<Config>.ninja\fP file will be generated for each of these
configurations (with \fB<Config>\fP being the configuration name.) These files
are intended to be run with \fBninja \-f build\-<Config>.ninja\fP\&. A
\fBbuild.ninja\fP file is also generated, using the configuration from either
\fI\%CMAKE_DEFAULT_BUILD_TYPE\fP or the first item from
\fI\%CMAKE_CONFIGURATION_TYPES\fP\&.
.sp
\fBcmake \-\-build . \-\-config <Config>\fP will always use \fBbuild\-<Config>.ninja\fP
to build. If no \fI\%\-\-config\fP argument is
specified, \fI\%cmake \-\-build .\fP will use \fBbuild.ninja\fP\&.
.sp
Each \fBbuild\-<Config>.ninja\fP file contains \fB<target>\fP targets as well as
\fB<target>:<Config>\fP targets, where \fB<Config>\fP is the same as the
configuration specified in \fBbuild\-<Config>.ninja\fP Additionally, if
cross\-config mode is enabled, \fBbuild\-<Config>.ninja\fP may contain
\fB<target>:<OtherConfig>\fP targets, where \fB<OtherConfig>\fP is a cross\-config,
as well as \fB<target>:all\fP, which builds the target in all cross\-configs. See
below for how to enable cross\-config mode.
.sp
The \fBNinja Multi\-Config\fP generator recognizes the following variables:
.INDENT 0.0
.TP
.B \fI\%CMAKE_CONFIGURATION_TYPES\fP
Specifies the total set of configurations to build. Unlike with other
multi\-config generators, this variable has a value of
\fBDebug;Release;RelWithDebInfo\fP by default.
.TP
.B \fI\%CMAKE_CROSS_CONFIGS\fP
Specifies a \fI\%semicolon\-separated list\fP of
configurations available from all \fBbuild\-<Config>.ninja\fP files.
.TP
.B \fI\%CMAKE_DEFAULT_BUILD_TYPE\fP
Specifies the configuration to use by default in a \fBbuild.ninja\fP file.
.TP
.B \fI\%CMAKE_DEFAULT_CONFIGS\fP
Specifies a \fI\%semicolon\-separated list\fP of
configurations to build for a target in \fBbuild.ninja\fP
if no \fB:<Config>\fP suffix is specified.
.UNINDENT
.sp
Consider the following example:
.INDENT 0.0
.INDENT 3.5
.sp
.EX
cmake_minimum_required(VERSION 3.16)
project(MultiConfigNinja C)

add_executable(generator generator.c)
add_custom_command(OUTPUT generated.c COMMAND generator generated.c)
add_library(generated ${CMAKE_BINARY_DIR}/generated.c)
.EE
.UNINDENT
.UNINDENT
.sp
Now assume you configure the project with \fBNinja Multi\-Config\fP and run one of
the following commands:
.INDENT 0.0
.INDENT 3.5
.sp
.EX
ninja \-f build\-Debug.ninja generated
# OR
cmake \-\-build . \-\-config Debug \-\-target generated
.EE
.UNINDENT
.UNINDENT
.sp
This would build the \fBDebug\fP configuration of \fBgenerator\fP, which would be
used to generate \fBgenerated.c\fP, which would be used to build the \fBDebug\fP
configuration of \fBgenerated\fP\&.
.sp
But if \fI\%CMAKE_CROSS_CONFIGS\fP is set to \fBall\fP, and you run the
following instead:
.INDENT 0.0
.INDENT 3.5
.sp
.EX
ninja \-f build\-Release.ninja generated:Debug
# OR
cmake \-\-build . \-\-config Release \-\-target generated:Debug
.EE
.UNINDENT
.UNINDENT
.sp
This would build the \fBRelease\fP configuration of \fBgenerator\fP, which would be
used to generate \fBgenerated.c\fP, which would be used to build the \fBDebug\fP
configuration of \fBgenerated\fP\&. This is useful for running a release\-optimized
version of a generator utility while still building the debug version of the
targets built with the generated code.
.SS Custom Commands
.sp
Added in version 3.20.

.sp
The \fBNinja Multi\-Config\fP generator adds extra capabilities to
\fI\%add_custom_command()\fP and \fI\%add_custom_target()\fP through its
cross\-config mode. The \fBCOMMAND\fP, \fBDEPENDS\fP, and \fBWORKING_DIRECTORY\fP
arguments can be evaluated in the context of either the \(dqcommand config\(dq (the
\(dqnative\(dq configuration of the \fBbuild\-<Config>.ninja\fP file in use) or the
\(dqoutput config\(dq (the configuration used to evaluate the \fBOUTPUT\fP and
\fBBYPRODUCTS\fP).
.sp
If either \fBOUTPUT\fP or \fBBYPRODUCTS\fP names a path that is common to
more than one configuration (e.g. it does not use any generator expressions),
all arguments are evaluated in the command config by default.
If all \fBOUTPUT\fP and \fBBYPRODUCTS\fP paths are unique to each configuration
(e.g. by using the \fI\%$<CONFIG>\fP generator expression), the first argument of
\fBCOMMAND\fP is still evaluated in the command config by default, while all
subsequent arguments, as well as the arguments to \fBDEPENDS\fP and
\fBWORKING_DIRECTORY\fP, are evaluated in the output config. These defaults can
be overridden with the \fI\%$<OUTPUT_CONFIG:...>\fP and \fI\%$<COMMAND_CONFIG:...>\fP
generator\-expressions. Note that if a target is specified by its name in
\fBDEPENDS\fP, or as the first argument of \fBCOMMAND\fP, it is always evaluated
in the command config, even if it is wrapped in \fI\%$<OUTPUT_CONFIG:...>\fP
(because its plain name is not a generator expression).
.sp
As an example, consider the following:
.INDENT 0.0
.INDENT 3.5
.sp
.EX
add_custom_command(
  OUTPUT \(dq$<CONFIG>.txt\(dq
  COMMAND
    generator \(dq$<CONFIG>.txt\(dq
              \(dq$<OUTPUT_CONFIG:$<CONFIG>>\(dq
              \(dq$<COMMAND_CONFIG:$<CONFIG>>\(dq
  DEPENDS
    tgt1
    \(dq$<TARGET_FILE:tgt2>\(dq
    \(dq$<OUTPUT_CONFIG:$<TARGET_FILE:tgt3>>\(dq
    \(dq$<COMMAND_CONFIG:$<TARGET_FILE:tgt4>>\(dq
  )
.EE
.UNINDENT
.UNINDENT
.sp
Assume that \fBgenerator\fP, \fBtgt1\fP, \fBtgt2\fP, \fBtgt3\fP, and \fBtgt4\fP are all
executable targets, and assume that \fB$<CONFIG>.txt\fP is built in the \fBDebug\fP
output config using the \fBRelease\fP command config. The \fBRelease\fP build of
the \fBgenerator\fP target is called with \fBDebug.txt Debug Release\fP as
arguments. The command depends on the \fBRelease\fP builds of \fBtgt1\fP and
\fBtgt4\fP, and the \fBDebug\fP builds of \fBtgt2\fP and \fBtgt3\fP\&.
.sp
\fBPRE_BUILD\fP, \fBPRE_LINK\fP, and \fBPOST_BUILD\fP custom commands for targets
only get run in their \(dqnative\(dq configuration (the \fBRelease\fP configuration in
the \fBbuild\-Release.ninja\fP file) unless they have no \fBBYPRODUCTS\fP or their
\fBBYPRODUCTS\fP are unique per config. Consider the following example:
.INDENT 0.0
.INDENT 3.5
.sp
.EX
add_executable(exe main.c)
add_custom_command(
  TARGET exe
  POST_BUILD
  COMMAND
    ${CMAKE_COMMAND} \-E echo \(dqRunning no\-byproduct command\(dq
  )
add_custom_command(
  TARGET exe
  POST_BUILD
  COMMAND
    ${CMAKE_COMMAND} \-E echo
    \(dqRunning separate\-byproduct command for $<CONFIG>\(dq
  BYPRODUCTS $<CONFIG>.txt
  )
add_custom_command(
  TARGET exe
  POST_BUILD
  COMMAND
    ${CMAKE_COMMAND} \-E echo
    \(dqRunning common\-byproduct command for $<CONFIG>\(dq
  BYPRODUCTS exe.txt
  )
.EE
.UNINDENT
.UNINDENT
.sp
In this example, if you build \fBexe:Debug\fP in \fBbuild\-Release.ninja\fP, the
first and second custom commands get run, since their byproducts are unique
per\-config, but the last custom command does not. However, if you build
\fBexe:Release\fP in \fBbuild\-Release.ninja\fP, all three custom commands get run.
.SS IDE Build Tool Generators
.sp
These generators support Integrated Development Environment (IDE)
project files.  Since the IDEs configure their own environment
one may launch CMake from any environment.
.SS Visual Studio Generators
.SS Visual Studio 6
.sp
Removed.  This once generated Visual Studio 6 project files, but the
generator has been removed since CMake 3.6.  It is still possible to
build with VS 6 tools using the \fI\%NMake Makefiles\fP generator.
.SS Visual Studio 7
.sp
Removed.  This once generated Visual Studio .NET 2002 project files, but
the generator has been removed since CMake 3.6.  It is still possible to
build with VS 7.0 tools using the \fI\%NMake Makefiles\fP generator.
.SS Visual Studio 7 .NET 2003
.sp
Removed.  This once generated Visual Studio .NET 2003 project files, but
the generator has been removed since CMake 3.9.  It is still possible to
build with VS 7.1 tools using the \fI\%NMake Makefiles\fP generator.
.SS Visual Studio 8 2005
.sp
Removed.  This once generated Visual Studio 8 2005 project files, but
the generator has been removed since CMake 3.12.  It is still possible to
build with VS 2005 tools using the \fI\%NMake Makefiles\fP generator.
.SS Visual Studio 9 2008
.sp
Removed.  This once generated Visual Studio 9 2008 project files, but
the generator has been removed since CMake 3.30.  It is still possible
to build with the VS 9 2008 toolset by also installing VS 10 2010 and
VS 2015 (or above) and using the \fI\%Visual Studio 14 2015\fP
generator (or above) with \fI\%CMAKE_GENERATOR_TOOLSET\fP set to \fBv90\fP,
or by using the \fI\%NMake Makefiles\fP generator.
.SS Visual Studio 10 2010
.sp
Removed.  This once generated Visual Studio 10 2010 project files, but
the generator has been removed since CMake 3.25.  It is still possible
to build with the VS 10 2010 toolset by also installing VS 2015 (or above)
and using the \fI\%Visual Studio 14 2015\fP (or above) generator with
\fI\%CMAKE_GENERATOR_TOOLSET\fP set to \fBv100\fP,
or by using the \fI\%NMake Makefiles\fP generator.
.SS Visual Studio 11 2012
.sp
Removed.  This once generated Visual Studio 11 2012 project files, but
the generator has been removed since CMake 3.28.  It is still possible
to build with the VS 11 2012 toolset by also installing VS 2015 (or above)
and using the \fI\%Visual Studio 14 2015\fP (or above) generator with
\fI\%CMAKE_GENERATOR_TOOLSET\fP set to \fBv110\fP,
or by using the \fI\%NMake Makefiles\fP generator.
.SS Visual Studio 12 2013
.sp
Removed.  This once generated Visual Studio 12 2013 project files, but
the generator has been removed since CMake 3.31.  It is still possible
to build with the VS 12 2013 toolset by also installing VS 2015 (or above)
and using the \fI\%Visual Studio 14 2015\fP (or above) generator with
\fI\%CMAKE_GENERATOR_TOOLSET\fP set to \fBv120\fP,
or by using the \fI\%NMake Makefiles\fP generator.
.SS Visual Studio 14 2015
.sp
Added in version 3.1.

.sp
Generates Visual Studio 14 (VS 2015) project files.
.SS Project Types
.sp
Only Visual C++ and C# projects may be generated (and Fortran with
Intel compiler integration).  Other types of projects (JavaScript,
Powershell, Python, etc.) are not supported.
.SS Platform Selection
.sp
The default target platform name (architecture) is \fBWin32\fP\&.
.sp
The \fI\%CMAKE_GENERATOR_PLATFORM\fP variable may be set, perhaps
via the \fI\%cmake \-A\fP option, to specify a target platform
name (architecture).  For example:
.INDENT 0.0
.IP \(bu 2
\fBcmake \-G \(dqVisual Studio 14 2015\(dq \-A Win32\fP
.IP \(bu 2
\fBcmake \-G \(dqVisual Studio 14 2015\(dq \-A x64\fP
.IP \(bu 2
\fBcmake \-G \(dqVisual Studio 14 2015\(dq \-A ARM\fP
.UNINDENT
.sp
Changed in version 4.0: Previously, for compatibility with CMake versions prior to 3.1,
one could specify a target platform name optionally at the
end of the generator name.  This has been removed.
This was supported only for:
.INDENT 0.0
.TP
.B \fBVisual Studio 14 2015 Win64\fP
Specify target platform \fBx64\fP\&.
.TP
.B \fBVisual Studio 14 2015 ARM\fP
Specify target platform \fBARM\fP\&.
.UNINDENT

.SS Toolset Selection
.sp
The \fBv140\fP toolset that comes with Visual Studio 14 2015 is selected by
default.  The \fI\%CMAKE_GENERATOR_TOOLSET\fP option may be set, perhaps
via the \fI\%cmake \-T\fP option, to specify another toolset.
.sp
Added in version 3.8: For each toolset that comes with this version of Visual Studio, there are
variants that are themselves compiled for 32\-bit (\fBx86\fP) and
64\-bit (\fBx64\fP) hosts (independent of the architecture they target).
By default this generator uses the 32\-bit variant even on a 64\-bit host.
One may explicitly request use of either the 32\-bit or 64\-bit host tools
by adding either \fBhost=x86\fP or \fBhost=x64\fP to the toolset specification.
See the \fI\%CMAKE_GENERATOR_TOOLSET\fP variable for details.

.sp
Added in version 3.14: Added support for \fBhost=x86\fP option.

.SS Windows 10 SDK Maximum Version for VS 2015
.sp
Added in version 3.19.

.sp
Microsoft stated in a \(dqWindows 10 October 2018 Update\(dq blog post that Windows
10 SDK versions (15063, 16299, 17134, 17763) are not supported by VS 2015 and
are only supported by VS 2017 and later.  Therefore by default CMake
automatically ignores Windows 10 SDKs beyond \fB10.0.14393.0\fP\&.
.sp
However, there are other recommendations for certain driver/Win32 builds that
indicate otherwise.  A user can override this behavior by either setting the
\fI\%CMAKE_VS_WINDOWS_TARGET_PLATFORM_VERSION_MAXIMUM\fP to a false value
or setting the \fI\%CMAKE_VS_WINDOWS_TARGET_PLATFORM_VERSION_MAXIMUM\fP to
the string value of the required maximum (e.g. \fB10.0.15063.0\fP).
.SS Visual Studio 15 2017
.sp
Added in version 3.7.1.

.sp
Generates Visual Studio 15 (VS 2017) project files.
.SS Project Types
.sp
Only Visual C++ and C# projects may be generated (and Fortran with
Intel compiler integration).  Other types of projects (JavaScript,
Powershell, Python, etc.) are not supported.
.SS Instance Selection
.sp
Added in version 3.11.

.sp
VS 2017 supports multiple installations on the same machine.  The
\fI\%CMAKE_GENERATOR_INSTANCE\fP variable may be used to select one.
.SS Platform Selection
.sp
The default target platform name (architecture) is \fBWin32\fP\&.
.sp
The \fI\%CMAKE_GENERATOR_PLATFORM\fP variable may be set, perhaps
via the \fI\%cmake \-A\fP option, to specify a target platform
name (architecture).  For example:
.INDENT 0.0
.IP \(bu 2
\fBcmake \-G \(dqVisual Studio 15 2017\(dq \-A Win32\fP
.IP \(bu 2
\fBcmake \-G \(dqVisual Studio 15 2017\(dq \-A x64\fP
.IP \(bu 2
\fBcmake \-G \(dqVisual Studio 15 2017\(dq \-A ARM\fP
.IP \(bu 2
\fBcmake \-G \(dqVisual Studio 15 2017\(dq \-A ARM64\fP
.UNINDENT
.sp
Changed in version 4.0: Previously, for compatibility with CMake versions prior to 3.1,
one could specify a target platform name optionally at the
end of the generator name.  This has been removed.
This was supported only for:
.INDENT 0.0
.TP
.B \fBVisual Studio 15 2017 Win64\fP
Specify target platform \fBx64\fP\&.
.TP
.B \fBVisual Studio 15 2017 ARM\fP
Specify target platform \fBARM\fP\&.
.UNINDENT

.SS Toolset Selection
.sp
The \fBv141\fP toolset that comes with Visual Studio 15 2017 is selected by
default.  The \fI\%CMAKE_GENERATOR_TOOLSET\fP option may be set, perhaps
via the \fI\%cmake \-T\fP option, to specify another toolset.
.sp
Added in version 3.8: For each toolset that comes with this version of Visual Studio, there are
variants that are themselves compiled for 32\-bit (\fBx86\fP) and
64\-bit (\fBx64\fP) hosts (independent of the architecture they target).
By default this generator uses the 32\-bit variant even on a 64\-bit host.
One may explicitly request use of either the 32\-bit or 64\-bit host tools
by adding either \fBhost=x86\fP or \fBhost=x64\fP to the toolset specification.
See the \fI\%CMAKE_GENERATOR_TOOLSET\fP variable for details.

.sp
Added in version 3.14: Added support for \fBhost=x86\fP option.

.SS Visual Studio 16 2019
.sp
Added in version 3.14.

.sp
Generates Visual Studio 16 (VS 2019) project files.
.SS Project Types
.sp
Only Visual C++ and C# projects may be generated (and Fortran with
Intel compiler integration).  Other types of projects (JavaScript,
Powershell, Python, etc.) are not supported.
.SS Instance Selection
.sp
VS 2019 supports multiple installations on the same machine.  The
\fI\%CMAKE_GENERATOR_INSTANCE\fP variable may be used to select one.
.SS Platform Selection
.sp
The default target platform name (architecture) is that of the host
and is provided in the \fI\%CMAKE_VS_PLATFORM_NAME_DEFAULT\fP variable.
.sp
The \fI\%CMAKE_GENERATOR_PLATFORM\fP variable may be set, perhaps
via the \fI\%cmake \-A\fP option, to specify a target platform
name (architecture).  For example:
.INDENT 0.0
.IP \(bu 2
\fBcmake \-G \(dqVisual Studio 16 2019\(dq \-A Win32\fP
.IP \(bu 2
\fBcmake \-G \(dqVisual Studio 16 2019\(dq \-A x64\fP
.IP \(bu 2
\fBcmake \-G \(dqVisual Studio 16 2019\(dq \-A ARM\fP
.IP \(bu 2
\fBcmake \-G \(dqVisual Studio 16 2019\(dq \-A ARM64\fP
.UNINDENT
.SS Toolset Selection
.sp
The \fBv142\fP toolset that comes with Visual Studio 16 2019 is selected by
default.  The \fI\%CMAKE_GENERATOR_TOOLSET\fP option may be set, perhaps
via the \fI\%cmake \-T\fP option, to specify another toolset.
.sp
For each toolset that comes with this version of Visual Studio, there are
variants that are themselves compiled for 32\-bit (\fBx86\fP) and
64\-bit (\fBx64\fP) hosts (independent of the architecture they target).
By default this generator uses the 64\-bit variant on x64 hosts and
the 32\-bit variant otherwise.
One may explicitly request use of either the 32\-bit or 64\-bit host tools
by adding either \fBhost=x86\fP or \fBhost=x64\fP to the toolset specification.
See the \fI\%CMAKE_GENERATOR_TOOLSET\fP variable for details.
.SS Visual Studio 17 2022
.sp
Added in version 3.21.

.sp
Generates Visual Studio 17 (VS 2022) project files.
.SS Project Types
.sp
Only Visual C++ and C# projects may be generated (and Fortran with
Intel compiler integration).  Other types of projects (JavaScript,
Powershell, Python, etc.) are not supported.
.SS Instance Selection
.sp
VS 2022 supports multiple installations on the same machine.  The
\fI\%CMAKE_GENERATOR_INSTANCE\fP variable may be used to select one.
.SS Platform Selection
.sp
The default target platform name (architecture) is that of the host
and is provided in the \fI\%CMAKE_VS_PLATFORM_NAME_DEFAULT\fP variable.
.sp
The \fI\%CMAKE_GENERATOR_PLATFORM\fP variable may be set, perhaps
via the \fI\%cmake \-A\fP option, to specify a target platform
name (architecture).  For example:
.INDENT 0.0
.IP \(bu 2
\fBcmake \-G \(dqVisual Studio 17 2022\(dq \-A Win32\fP
.IP \(bu 2
\fBcmake \-G \(dqVisual Studio 17 2022\(dq \-A x64\fP
.IP \(bu 2
\fBcmake \-G \(dqVisual Studio 17 2022\(dq \-A ARM\fP
.IP \(bu 2
\fBcmake \-G \(dqVisual Studio 17 2022\(dq \-A ARM64\fP
.UNINDENT
.SS Toolset Selection
.sp
The \fBv143\fP toolset that comes with VS 17 2022 is selected by default.
The \fI\%CMAKE_GENERATOR_TOOLSET\fP option may be set, perhaps
via the \fI\%cmake \-T\fP option, to specify another toolset.
.sp
For each toolset that comes with this version of Visual Studio, there are
variants that are themselves compiled for 32\-bit (\fBx86\fP) and
64\-bit (\fBx64\fP) hosts (independent of the architecture they target).
By default this generator uses the 64\-bit variant on x64 hosts and
the 32\-bit variant otherwise.
One may explicitly request use of either the 32\-bit or 64\-bit host tools
by adding either \fBhost=x86\fP or \fBhost=x64\fP to the toolset specification.
See the \fI\%CMAKE_GENERATOR_TOOLSET\fP variable for details.
.SS Other Generators
.SS Green Hills MULTI
.sp
Added in version 3.3.

.sp
Added in version 3.15: Linux support.

.sp
Generates Green Hills MULTI project files (experimental, work\-in\-progress).
.INDENT 0.0
.INDENT 3.5
The buildsystem has predetermined build\-configuration settings that can be controlled
via the \fI\%CMAKE_BUILD_TYPE\fP variable.
.UNINDENT
.UNINDENT
.SS Platform Selection
.sp
Added in version 3.13.

.sp
The variable \fBGHS_PRIMARY_TARGET\fP can be used to select the target platform.
.INDENT 0.0
.INDENT 3.5
.nf
Sets \fBprimaryTarget\fP entry in project file.
.fi
.sp
.UNINDENT
.UNINDENT
.sp
For example:
.INDENT 0.0
.IP \(bu 2
\fBcmake \-G \(dqGreen Hills MULTI\(dq \-D GHS_PRIMARY_TARGET=ppc_integrity.tgt\fP
.UNINDENT
.sp
Otherwise the \fBprimaryTarget\fP will be composed from the values of \fI\%CMAKE_GENERATOR_PLATFORM\fP
and \fBGHS_TARGET_PLATFORM\fP\&. Defaulting to the value of \fBarm_integrity.tgt\fP
.INDENT 0.0
.IP \(bu 2
The \fI\%CMAKE_GENERATOR_PLATFORM\fP variable may be set, perhaps
via the \fI\%cmake \-A\fP option.
.nf
Typical values of \fBarm\fP, \fBppc\fP, \fB86\fP, etcetera, are used.
.fi
.sp
.IP \(bu 2
The variable \fBGHS_TARGET_PLATFORM\fP may be set, perhaps via the \fI\%cmake \-D\fP
option.
.nf
Defaults to \fBintegrity\fP\&.
Usual values are \fBintegrity\fP, \fBthreadx\fP, \fBuvelosity\fP, \fBvelosity\fP,
\fBvxworks\fP, \fBstandalone\fP\&.
.fi
.sp
.UNINDENT
.sp
For example:
.INDENT 0.0
.IP \(bu 2
\fBcmake \-G \(dqGreen Hills MULTI\(dq\fP for \fBarm_integrity.tgt\fP\&.
.IP \(bu 2
\fBcmake \-G \(dqGreen Hills MULTI\(dq \-A 86\fP for \fB86_integrity.tgt\fP\&.
.IP \(bu 2
\fBcmake \-G \(dqGreen Hills MULTI\(dq \-D GHS_TARGET_PLATFORM=standalone\fP for \fBarm_standalone.tgt\fP\&.
.IP \(bu 2
\fBcmake \-G \(dqGreen Hills MULTI\(dq \-A ppc \-D GHS_TARGET_PLATFORM=standalone\fP for \fBppc_standalone.tgt\fP\&.
.UNINDENT
.SS Toolset Selection
.sp
Added in version 3.13.

.sp
The generator searches for the latest compiler or can be given a location to use.
\fBGHS_TOOLSET_ROOT\fP is the directory that is checked for the latest compiler.
.INDENT 0.0
.IP \(bu 2
The \fI\%CMAKE_GENERATOR_TOOLSET\fP option may be set, perhaps
via the \fI\%cmake \-T\fP option, to specify the location of the toolset.
Both absolute and relative paths are valid. Paths are relative to \fBGHS_TOOLSET_ROOT\fP\&.
.IP \(bu 2
The variable \fBGHS_TOOLSET_ROOT\fP may be set, perhaps via the \fI\%cmake \-D\fP
option.
.nf
Root path for toolset searches and relative paths.
Defaults to \fBC:/ghs\fP in Windows or \fB/usr/ghs\fP in Linux.
.fi
.sp
.UNINDENT
.sp
For example, setting a specific compiler:
.INDENT 0.0
.IP \(bu 2
\fBcmake \-G \(dqGreen Hills MULTI\(dq \-T comp_201754\fP for \fB/usr/ghs/comp_201754\fP\&.
.IP \(bu 2
\fBcmake \-G \(dqGreen Hills MULTI\(dq \-T comp_201754 \-D GHS_TOOLSET_ROOT=/opt/ghs\fP for \fB/opt/ghs/comp_201754\fP\&.
.IP \(bu 2
\fBcmake \-G \(dqGreen Hills MULTI\(dq \-T /usr/ghs/comp_201554\fP
.IP \(bu 2
\fBcmake \-G \(dqGreen Hills MULTI\(dq \-T C:/ghs/comp_201754\fP
.UNINDENT
.sp
For example, searching for latest compiler:
.INDENT 0.0
.IP \(bu 2
\fBcmake \-G \(dqGreen Hills MULTI\(dq\fP for searching \fB/usr/ghs\fP\&.
.IP \(bu 2
\fBcmake \-G \(dqGreen Hills MULTI \-D GHS_TOOLSET_ROOT=/opt/ghs\(dq\fP for searching \fB/opt/ghs\fP\&.
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
The \fI\%CMAKE_GENERATOR_TOOLSET\fP should use CMake style paths.
.UNINDENT
.UNINDENT
.SS OS and BSP Selection
.sp
Added in version 3.3.

.sp
Certain target platforms, like Integrity, require an OS.  The RTOS directory path
can be explicitly set using \fBGHS_OS_DIR\fP\&.  Otherwise \fBGHS_OS_ROOT\fP will be
searched for the latest Integrity RTOS.
.sp
If the target platform, like Integrity, requires a BSP name then it can be set via
the \fBGHS_BSP_NAME\fP variable.
.INDENT 0.0
.IP \(bu 2
\fBGHS_OS_DIR\fP and \fBGHS_OS_DIR_OPTION\fP
.nf
Sets \fB\-os_dir\fP entry in project file.
.fi
.sp
.nf
\fBGHS_OS_DIR_OPTION\fP default value is \fB\-os_dir\fP\&.
.fi
.sp
.sp
Added in version 3.15: The \fBGHS_OS_DIR_OPTION\fP variable.

.sp
For example:
.INDENT 2.0
.IP \(bu 2
\fBcmake \-G \(dqGreen Hills MULTI\(dq \-D GHS_OS_DIR=/usr/ghs/int1144\fP
.UNINDENT
.IP \(bu 2
\fBGHS_OS_ROOT\fP
.nf
Root path for RTOS searches.
Defaults to \fBC:/ghs\fP in Windows or \fB/usr/ghs\fP in Linux.
.fi
.sp
.sp
For example:
.INDENT 2.0
.IP \(bu 2
\fBcmake \-G \(dqGreen Hills MULTI\(dq \-D GHS_OS_ROOT=/opt/ghs\fP
.UNINDENT
.IP \(bu 2
\fBGHS_BSP_NAME\fP
.nf
Sets \fB\-bsp\fP entry in project file.
Defaults to \fBsim<arch>\fP for \fBintegrity\fP platforms.
.fi
.sp
.sp
For example:
.INDENT 2.0
.IP \(bu 2
\fBcmake \-G \(dqGreen Hills MULTI\(dq\fP for \fBsimarm\fP on \fBarm_integrity.tgt\fP\&.
.IP \(bu 2
\fBcmake \-G \(dqGreen Hills MULTI\(dq \-A 86\fP for \fBsim86\fP on \fB86_integrity.tgt\fP\&.
.IP \(bu 2
\fBcmake \-G \(dqGreen Hills MULTI\(dq \-A ppc \-D GHS_BSP_NAME=sim800\fP for \fBsim800\fP
on \fBppc_integrity.tgt\fP\&.
.IP \(bu 2
\fBcmake \-G \(dqGreen Hills MULTI\(dq \-D GHS_PRIMARY_TARGET=ppc_integrity.tgt \-D GHS_BSP_NAME=fsl\-t1040\fP
for \fBfsl\-t1040\fP on \fBppc_integrity.tgt\fP\&.
.UNINDENT
.UNINDENT
.SS Target Properties
.sp
Added in version 3.14.

.sp
The following properties are available:
.INDENT 0.0
.IP \(bu 2
\fI\%GHS_INTEGRITY_APP\fP
.IP \(bu 2
\fI\%GHS_NO_SOURCE_GROUP_FILE\fP
.UNINDENT
.SS MULTI Project Variables
.sp
Added in version 3.3.

.sp
Adding a Customization file and macros are available through the use of the following
variables:
.INDENT 0.0
.IP \(bu 2
\fBGHS_CUSTOMIZATION\fP \- CMake path name to Customization File.
.IP \(bu 2
\fBGHS_GPJ_MACROS\fP \- CMake list of Macros.
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
This generator is deemed experimental as of CMake 4.1.1
and is still a work in progress.  Future versions of CMake
may make breaking changes as the generator matures.
.UNINDENT
.UNINDENT
.SS Xcode
.sp
Generate Xcode project files.
.sp
Changed in version 3.15: This generator supports Xcode 5.0 and above.

.SS Toolset and Build System Selection
.sp
By default Xcode is allowed to select its own default toolchain.
The \fI\%CMAKE_GENERATOR_TOOLSET\fP option may be set, perhaps
via the \fI\%cmake \-T\fP option, to specify another toolset.
.sp
Added in version 3.19: This generator supports toolset specification using one of these forms:

.INDENT 0.0
.IP \(bu 2
\fBtoolset\fP
.IP \(bu 2
\fBtoolset[,key=value]*\fP
.IP \(bu 2
\fBkey=value[,key=value]*\fP
.UNINDENT
.sp
The \fBtoolset\fP specifies the toolset name.  The selected toolset name
is provided in the \fI\%CMAKE_XCODE_PLATFORM_TOOLSET\fP variable.
.sp
The \fBkey=value\fP pairs form a comma\-separated list of options to
specify generator\-specific details of the toolset selection.
Supported pairs are:
.INDENT 0.0
.TP
.B \fBbuildsystem=<variant>\fP
Specify the buildsystem variant to use.
See the \fI\%CMAKE_XCODE_BUILD_SYSTEM\fP variable for allowed values.
.sp
For example, to select the original build system under Xcode 12,
run \fI\%cmake(1)\fP with the option \fI\%\-T buildsystem=1\fP\&.
.UNINDENT
.SS Swift Support
.sp
Added in version 3.4.

.sp
When using the \fBXcode\fP generator with Xcode 6.1 or higher,
one may enable the \fBSwift\fP language with the \fI\%enable_language()\fP
command or the \fI\%project()\fP\&.
.SS Limitations
.sp
The Xcode generator does not support per\-configuration sources.
Code like the following will result in a generation error:
.INDENT 0.0
.INDENT 3.5
.sp
.EX
add_executable(MyApp mymain\-$<CONFIG>.cpp)
.EE
.UNINDENT
.UNINDENT
.SH EXTRA GENERATORS
.sp
Deprecated since version 3.27: Support for \(dqExtra Generators\(dq is deprecated and will be removed from
a future version of CMake.  IDEs may use the \fI\%cmake\-file\-api(7)\fP
to view CMake\-generated project build trees.

.sp
Some of the \fI\%CMake Generators\fP listed in the \fI\%cmake(1)\fP
command\-line tool \fI\%\-\-help\fP output may have
variants that specify an extra generator for an auxiliary IDE tool.
Such generator names have the form \fB<extra\-generator> \- <main\-generator>\fP\&.
The following extra generators are known to CMake.
.SS CodeBlocks
.sp
Deprecated since version 3.27: Support for \fI\%Extra Generators\fP is deprecated and will be removed from
a future version of CMake.  IDEs may use the \fI\%cmake\-file\-api(7)\fP
to view CMake\-generated project build trees.

.sp
Generates CodeBlocks project files.
.sp
Project files for CodeBlocks will be created in the top directory and
in every subdirectory which features a \fBCMakeLists.txt\fP file containing
a \fI\%project()\fP call.  Additionally a hierarchy of makefiles is generated
into the build tree.
The appropriate make program can build the
project through the default \fBall\fP target.  An \fBinstall\fP target is
also provided.
.sp
Added in version 3.10: The \fI\%CMAKE_CODEBLOCKS_EXCLUDE_EXTERNAL_FILES\fP variable may
be set to \fBON\fP to exclude any files which are located outside of
the project root directory.

.sp
This \(dqextra\(dq generator may be specified as:
.INDENT 0.0
.TP
.B \fBCodeBlocks \- MinGW Makefiles\fP
Generate with \fI\%MinGW Makefiles\fP\&.
.TP
.B \fBCodeBlocks \- NMake Makefiles\fP
Generate with \fI\%NMake Makefiles\fP\&.
.TP
.B \fBCodeBlocks \- NMake Makefiles JOM\fP
Added in version 3.8: Generate with \fI\%NMake Makefiles JOM\fP\&.

.TP
.B \fBCodeBlocks \- Ninja\fP
Generate with \fI\%Ninja\fP\&.
.TP
.B \fBCodeBlocks \- Unix Makefiles\fP
Generate with \fI\%Unix Makefiles\fP\&.
.UNINDENT
.SS CodeLite
.sp
Deprecated since version 3.27: Support for \fI\%Extra Generators\fP is deprecated and will be removed from
a future version of CMake.  IDEs may use the \fI\%cmake\-file\-api(7)\fP
to view CMake\-generated project build trees.

.sp
Generates CodeLite project files.
.sp
Project files for CodeLite will be created in the top directory and
in every subdirectory which features a CMakeLists.txt file containing
a \fI\%project()\fP call.
The appropriate make program can build the
project through the default \fBall\fP target.  An \fBinstall\fP target
is also provided.
.sp
Added in version 3.7: The \fI\%CMAKE_CODELITE_USE_TARGETS\fP variable may be set to \fBON\fP
to change the default behavior from projects to targets as the basis
for project files.

.sp
This \(dqextra\(dq generator may be specified as:
.INDENT 0.0
.TP
.B \fBCodeLite \- MinGW Makefiles\fP
Generate with \fI\%MinGW Makefiles\fP\&.
.TP
.B \fBCodeLite \- NMake Makefiles\fP
Generate with \fI\%NMake Makefiles\fP\&.
.TP
.B \fBCodeLite \- Ninja\fP
Generate with \fI\%Ninja\fP\&.
.TP
.B \fBCodeLite \- Unix Makefiles\fP
Generate with \fI\%Unix Makefiles\fP\&.
.UNINDENT
.SS Eclipse CDT4
.sp
Deprecated since version 3.27: Support for \fI\%Extra Generators\fP is deprecated and will be removed from
a future version of CMake.  IDEs may use the \fI\%cmake\-file\-api(7)\fP
to view CMake\-generated project build trees.

.sp
Generates Eclipse CDT 4.0 project files.
.sp
Project files for Eclipse will be created in the top directory.  In
out of source builds, a linked resource to the top level source
directory will be created.  Additionally a hierarchy of makefiles is
generated into the build tree.  The appropriate make program can build
the project through the default \fBall\fP target.  An \fBinstall\fP target
is also provided.
.sp
This \(dqextra\(dq generator may be specified as:
.INDENT 0.0
.TP
.B \fBEclipse CDT4 \- MinGW Makefiles\fP
Generate with \fI\%MinGW Makefiles\fP\&.
.TP
.B \fBEclipse CDT4 \- NMake Makefiles\fP
Generate with \fI\%NMake Makefiles\fP\&.
.TP
.B \fBEclipse CDT4 \- Ninja\fP
Generate with \fI\%Ninja\fP\&.
.TP
.B \fBEclipse CDT4 \- Unix Makefiles\fP
Generate with \fI\%Unix Makefiles\fP\&.
.UNINDENT
.SS Kate
.sp
Deprecated since version 3.27: Support for \fI\%Extra Generators\fP is deprecated and will be removed from
a future version of CMake.  IDEs may use the \fI\%cmake\-file\-api(7)\fP
to view CMake\-generated project build trees.

.sp
Generates Kate project files.
.sp
A project file for Kate will be created in the top directory in the top level
build directory.
To use it in Kate, the Project plugin must be enabled.
The project file is loaded in Kate by opening the
\fBProjectName.kateproject\fP file in the editor.
If the Kate Build\-plugin is enabled, all targets generated by CMake are
available for building.
.sp
This \(dqextra\(dq generator may be specified as:
.INDENT 0.0
.TP
.B \fBKate \- MinGW Makefiles\fP
Generate with \fI\%MinGW Makefiles\fP\&.
.TP
.B \fBKate \- NMake Makefiles\fP
Generate with \fI\%NMake Makefiles\fP\&.
.TP
.B \fBKate \- Ninja\fP
Generate with \fI\%Ninja\fP\&.
.TP
.B \fBKate \- Ninja Multi\-Config\fP
Generate with \fI\%Ninja Multi\-Config\fP\&.
.TP
.B \fBKate \- Unix Makefiles\fP
Generate with \fI\%Unix Makefiles\fP\&.
.UNINDENT
.SS Sublime Text 2
.sp
Deprecated since version 3.27: Support for \fI\%Extra Generators\fP is deprecated and will be removed from
a future version of CMake.  IDEs may use the \fI\%cmake\-file\-api(7)\fP
to view CMake\-generated project build trees.

.sp
Generates Sublime Text 2 project files.
.sp
Project files for Sublime Text 2 will be created in the top directory
and in every subdirectory which features a \fBCMakeLists.txt\fP file
containing a \fI\%project()\fP call.  Additionally \fBMakefiles\fP
(or \fBbuild.ninja\fP files) are generated into the build tree.
The appropriate make program can build the project through the default \fBall\fP
target.  An \fBinstall\fP target is also provided.
.sp
This \(dqextra\(dq generator may be specified as:
.INDENT 0.0
.TP
.B \fBSublime Text 2 \- MinGW Makefiles\fP
Generate with \fI\%MinGW Makefiles\fP\&.
.TP
.B \fBSublime Text 2 \- NMake Makefiles\fP
Generate with \fI\%NMake Makefiles\fP\&.
.TP
.B \fBSublime Text 2 \- Ninja\fP
Generate with \fI\%Ninja\fP\&.
.TP
.B \fBSublime Text 2 \- Unix Makefiles\fP
Generate with \fI\%Unix Makefiles\fP\&.
.UNINDENT
.SH COPYRIGHT
2000-2025 Kitware, Inc. and Contributors
.\" Generated by docutils manpage writer.
.
